View Mask

Description

Obtains the switch mask of a sub-unit. The result fills the number of least significant bits corresponding to the size of the sub-unit.

Prototype

DWORD PIPLX_ViewMask(SESSION session, DWORD CardNum, DWORD OutSub, DWORD *Data, DWORD DataLen);

Parameters:

Session - the SESSION variable for the connected LXI device

CardNum - card number

OutSub - output sub-unit number

Data - pointer to the one-dimensional array (vector) to receive the result

DataLen - length of the above array in BYTES (Note - BYTES not DWORDs !)

Returns:

Zero for success, or non-zero error code.

Note

For a Matrix sub-unit, the result is folded into the vector on its row-axis: see Data Formats.

Warning

The data array pointed to must contain sufficient bits to hold the bit-pattern for the specified sub-unit, or adjacent memory will be overwritten, causing data corruption and/or a program crash.

Example Code

See the description of PIPLX_WriteSub for example code using an array-based function.